Account Management Biz Api

(0 reviews)

PATCH-billingAccountById(Enable or Disable Autopay)

PATCH

This operation allows partial updates of a account entity. Attribute selection is enabled for all first level attributes.

Request

This section defines all the possible data structures sent by the client when consuming the method.

URL PARAMS

name	type	description	required
businessId	string	2 letter ISO 3166 country code (PR) identifying the business unit.	Y
id	string	Unique identifier of the account	Y

Security Headers

name	type	description	required
client_id	string	The client_id identifying the channel. Minimum characters: 5	Y
client_secret	string	Password associated with the client_id. Minimum characters: 5	Y

name	type	description	required
X-Correlation-ID	string	Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.	N
channelId	string	This is to identify the source (Project). Value : BUS DIGITAL Conditionally Mandatory. It is Mandatory only for B2B as there are underlying routing conditions based on channelId received	Conditionally Mandatory
lob	string	The Line of Business Identifier enum: ["FIXED", "PREPAID", "POSTPAID"]	Conditionally Mandatory
targetSystem	string	Use this data type to indicate target system name/id in your request.	Conditionally Mandatory

Body

Request Body for PR

      {
        "defaultPaymentMethod": {
          "@referredType": "Autopay",
          "id": "72"
        },
        "extendedCharacteristic": [
          {
            "value": "Digital",
            "name": "sourceSystem"
          },

           {
            "value": "true",
            "name": "restrictOrder"
          }

        ]
      }

Possible values for "@referredType" are "Autopay","disableAutopay".

Definitions

Each of the request parameters is detailed.

name	type	description	required
defaultPaymentMethod	Object		Y
defaultPaymentMethod.@referredType	String	The actual type of the target instance when needed for disambiguation.	Y
defaultPaymentMethod.id	String	Unique identifier for the EntityRef	Y
extendedCharacteristic	Array	Describes a given extendedCharacteristic of an object or entity through a name/value pair.	Y
extendedCharacteristic.name	String	Name of the extendedCharacteristic	Y
extendedCharacteristic.value	String	The value of the extendedCharacteristic	Y

Response

In this section all the possible data structures received by the client at the moment of responding the method are defined.

Possible response success

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

[ 200 ]

OK - PATCH request processed successfully, response body contains an entity corresponding to the requested resource.

      {
        "status": 200,
        "description": "Autopay change request received"
      }